/*
 * sysmo 服务器监控图表类
 * Copyright (C) 2009  YuLicheng
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.sysmo.server.node.item.graphgroup;

import java.util.List;
import org.sysmo.db.DatabaseInterface;
import org.sysmo.server.graph.Graph;
import org.sysmo.server.node.item.Item;
import org.sysmo.server.node.item.Result;
import org.sysmo.server.node.item.graphgroup.value.Value;
import org.sysmo.server.node.item.graphgroup.value.ValueExistsException;
import org.sysmo.server.util.TimeInterval;

/**
 *
 * 监控项中的图表对象。一个图表中可包含多个监控值。由于对图表的元数据修改不需要
 * 通知客户端，而且监控数据的传送也是依靠监控项传递的，因此不需要与客户端进行
 * 通讯。
 *
 * @author YuLicheng
 * @see Item
 */
public class GraphGroup {

    /**
     * 指定图表类型的枚举。图表类型是各监控值记录在同一图表上的呈现方式。
     * 
     * @see #getGraphType()
     * @see #setGraphType(GraphType)
     */
    public enum GraphType {
        /**
         * 普通类型（折线图）。
         */
        NORMAL,
        /**
         * 面积叠加图。
         */
        AREA;
    };

    private DatabaseInterface dbInterface;
    private int id;

    /**
     * 实例化数据库中已存在的监控图表。
     *
     * @param dbInterface 数据库访问接口。
     * @param id 已存在的监控项ID。
     * @throws GraphGroupNotExistsException 若图表ID不存在则抛出此异常。
     */
    public GraphGroup(DatabaseInterface dbInterface, int id)
            throws GraphGroupNotExistsException {
        this.dbInterface = dbInterface;
        this.id = id;
    }

    /**
     * 创建一个新的监控图表。
     *
     * @param dbInterface 数据库访问接口。
     * @param name 新监控项名称。
     * @param itemID 所属监控项ID。
     * @throws GraphGroupExistsException 若图表名称已存在则抛出此异常。
     */
    public GraphGroup(DatabaseInterface dbInterface, String name, int itemID)
            throws GraphGroupExistsException {
        this.dbInterface = dbInterface;
    }

    /**
     * 返回图表名称。
     *
     * @return 图表名称。
     */
    public String getName() {
        return null;
    }

    /**
     * 设置图表名称。
     *
     * @param name 图表新名称。
     * @throws GraphGroupExistsException 若存在同名图表则抛出此异常。
     */
    public void setName(String name) throws GraphGroupExistsException {

    }

    /**
     * 返回此图表ID。
     *
     * @return 图表ID。
     */
    public int getID() {
        return id;
    }

    /**
     * 返回此图表类型。
     *
     * @return 图表类型。
     */
    public GraphType getGraphType() {
        return null;
    }

    /**
     * 更改图表类型。
     *
     * @param graphType 新图表类型。
     * @see GraphType
     */
    public void setGraphType(GraphType graphType) {
        
    }

    /**
     * 在当前图表中增加新的监控值。
     * 
     * @param name 新监控值名称。
     * @return 监控值对象。
     * @throws ValueExistsException 若存在同名监控值，则抛出此异常。
     */
    public Value addValue(String name) throws ValueExistsException {
        return null;
    }

    /**
     * 返回指定的监控值对象。
     *
     * @param valueID 监控值ID。
     * @return 监控值对象。
     */
    public Value getValue(int valueID) {
        return null;
    }

    /**
     * 返回所有此图表中的监控值对象组成的列表。
     *
     * @return 监控值对象列表。
     */
    public List<Value> getAllValues() {
        return null;
    }

    /**
     * 保存客户端发送的监控数据。此方法会将相应的数据存入数据库。
     * <br />
     *
     * 此方法会忽略非本图表的记录，并调用相应的监控值的saveData方法来存储。
     *
     * @param values 监控结果集合。
     */
    public void saveData(List<Result> values) {

    }

    /**
     * 按时间获取图表。
     * <br />
     *
     * 此方法会用指定时间段内的数据调用图表绘制模块绘制图表。
     *
     * @param dataRange 数据时间段。
     * @return 图表对象。
     */
    public Graph getGraph(TimeInterval dataRange) {
        return null;
    }
    
}
